<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Alfar Engine: AlfarEngine.Engine Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Alfar Engine
   
   </div>
   <div id="projectbrief">A little 2D engine managing a scene</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespace_alfar_engine.html">AlfarEngine</a>      </li>
      <li class="navelem"><a class="el" href="class_alfar_engine_1_1_engine.html">Engine</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#properties">Properties</a>  </div>
  <div class="headertitle">
<div class="title">AlfarEngine.Engine Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="AlfarEngine::Engine" -->
<p>The Main class that encapsulate all the information and operation of the <a class="el" href="class_alfar_engine_1_1_engine.html" title="The Main class that encapsulate all the information and operation of the Engine.">Engine</a>.  
 <a href="class_alfar_engine_1_1_engine.html#details">More...</a></p>

<p><a href="class_alfar_engine_1_1_engine-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_alfar_engine_1_1_engine.html#a52e9912fdfa628119687d3d66956725d">Initialize</a> (Game pGame, GraphicsDeviceManager pManager)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the engine.  <a href="#a52e9912fdfa628119687d3d66956725d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_alfar_engine_1_1_engine.html#ac14f915893a634804ee10afa8c0c102a">Update</a> (GameTime pTime)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Update all the state of the <a class="el" href="class_alfar_engine_1_1_engine.html" title="The Main class that encapsulate all the information and operation of the Engine.">Engine</a> (Animations, physics, movement etc...)  <a href="#ac14f915893a634804ee10afa8c0c102a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_alfar_engine_1_1_engine.html#ac8938923ce9ba3d165984615b90527ec">Draw</a> (GameTime pTime)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Draw the Cameras viewports onto the backbuffer.  <a href="#ac8938923ce9ba3d165984615b90527ec"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="properties"></a>
Properties</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_alfar_engine_1_1_game_object.html">GameObject</a>[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_alfar_engine_1_1_engine.html#a35eb0a83f1cefc4bd7d05efb0c268fda">root</a><code> [get]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the array of root of the engine. 0 is the upper. maxLayer is the lower layer.  <a href="#a35eb0a83f1cefc4bd7d05efb0c268fda"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63ffc0cc92f5de6fcd55798a679a3da2"></a><!-- doxytag: member="AlfarEngine::Engine::Content" ref="a63ffc0cc92f5de6fcd55798a679a3da2" args="" -->
static ContentManager&#160;</td><td class="memItemRight" valign="bottom"><b>Content</b><code> [get]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afddc1fa4e53fd1208309f9eac85ebf4d"></a><!-- doxytag: member="AlfarEngine::Engine::spriteBatch" ref="afddc1fa4e53fd1208309f9eac85ebf4d" args="" -->
static SpriteBatch&#160;</td><td class="memItemRight" valign="bottom"><b>spriteBatch</b><code> [get]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80fd7a5d83b44b5705a1badc9bb33e69"></a><!-- doxytag: member="AlfarEngine::Engine::game" ref="a80fd7a5d83b44b5705a1badc9bb33e69" args="" -->
static Game&#160;</td><td class="memItemRight" valign="bottom"><b>game</b><code> [get]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5624cddc65f71031362620fc2351d91a"></a><!-- doxytag: member="AlfarEngine::Engine::maxLayer" ref="a5624cddc65f71031362620fc2351d91a" args="" -->
static int&#160;</td><td class="memItemRight" valign="bottom"><b>maxLayer</b><code> [get]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abed969b738bae78cb2b94e7b3682bf32"></a><!-- doxytag: member="AlfarEngine::Engine::resolution" ref="abed969b738bae78cb2b94e7b3682bf32" args="" -->
static Vector2&#160;</td><td class="memItemRight" valign="bottom"><b>resolution</b><code> [get]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_alfar_engine_1_1_engine.html#ae81cdaae63518dba89e1dd00f4d72a87">ambientLight</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">the ambient light factor. 0 mean no ambient light (dark) 1 mean full ambient. Default is 0  <a href="#ae81cdaae63518dba89e1dd00f4d72a87"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The Main class that encapsulate all the information and operation of the <a class="el" href="class_alfar_engine_1_1_engine.html" title="The Main class that encapsulate all the information and operation of the Engine.">Engine</a>. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac8938923ce9ba3d165984615b90527ec"></a><!-- doxytag: member="AlfarEngine::Engine::Draw" ref="ac8938923ce9ba3d165984615b90527ec" args="(GameTime pTime)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void AlfarEngine.Engine.Draw </td>
          <td>(</td>
          <td class="paramtype">GameTime&#160;</td>
          <td class="paramname"><em>pTime</em></td><td>)</td>
          <td><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Draw the Cameras viewports onto the backbuffer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">pTime</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a52e9912fdfa628119687d3d66956725d"></a><!-- doxytag: member="AlfarEngine::Engine::Initialize" ref="a52e9912fdfa628119687d3d66956725d" args="(Game pGame, GraphicsDeviceManager pManager)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void AlfarEngine.Engine.Initialize </td>
          <td>(</td>
          <td class="paramtype">Game&#160;</td>
          <td class="paramname"><em>pGame</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">GraphicsDeviceManager&#160;</td>
          <td class="paramname"><em>pManager</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initialize the engine. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">pGame</td><td>The Game class you use the engine in</td></tr>
    <tr><td class="paramname">pManager</td><td>The Graphics Manager constructed in your game class</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ac14f915893a634804ee10afa8c0c102a"></a><!-- doxytag: member="AlfarEngine::Engine::Update" ref="ac14f915893a634804ee10afa8c0c102a" args="(GameTime pTime)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void AlfarEngine.Engine.Update </td>
          <td>(</td>
          <td class="paramtype">GameTime&#160;</td>
          <td class="paramname"><em>pTime</em></td><td>)</td>
          <td><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Update all the state of the <a class="el" href="class_alfar_engine_1_1_engine.html" title="The Main class that encapsulate all the information and operation of the Engine.">Engine</a> (Animations, physics, movement etc...) </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">pTime</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Property Documentation</h2>
<a class="anchor" id="ae81cdaae63518dba89e1dd00f4d72a87"></a><!-- doxytag: member="AlfarEngine::Engine::ambientLight" ref="ae81cdaae63518dba89e1dd00f4d72a87" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float AlfarEngine.Engine.ambientLight<code> [static, get, set]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>the ambient light factor. 0 mean no ambient light (dark) 1 mean full ambient. Default is 0 </p>

</div>
</div>
<a class="anchor" id="a35eb0a83f1cefc4bd7d05efb0c268fda"></a><!-- doxytag: member="AlfarEngine::Engine::root" ref="a35eb0a83f1cefc4bd7d05efb0c268fda" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_alfar_engine_1_1_game_object.html">GameObject</a> [] AlfarEngine.Engine.root<code> [static, get]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return the array of root of the engine. 0 is the upper. maxLayer is the lower layer. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>E:/XNA/alfarEngine/AlfarEngine/Engine.cs</li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Properties</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Mon Jan 16 2012 09:38:38 for Alfar Engine by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>

</body>
</html>
